docs: Rename files to match type and version
authorEmmanuele Bassi <ebassi@gnome.org>
Wed, 19 Apr 2017 10:31:08 +0000 (11:31 +0100)
committerEmmanuele Bassi <ebassi@gnome.org>
Wed, 3 May 2017 14:10:56 +0000 (15:10 +0100)
The main GDK API reference index is XML, not SGML.

The overrides file is for GDK 4.x, not 3.x.

docs/reference/gdk/Makefile.am
docs/reference/gdk/gdk-docs.sgml [deleted file]
docs/reference/gdk/gdk3-overrides.txt [deleted file]
docs/reference/gdk/gdk4-docs.xml [new file with mode: 0644]
docs/reference/gdk/gdk4-overrides.txt [new file with mode: 0644]

index cb10af42af6b9a4b93758c2c6d5c51560917110a..8c78f1aaa57c5c1f00b72d5e4ae40c22951950fc 100644 (file)
@@ -6,7 +6,7 @@ AUTOMAKE_OPTIONS = 1.6
 DOC_MODULE=gdk4
 
 # The top-level SGML file.
-DOC_MAIN_SGML_FILE=gdk-docs.sgml
+DOC_MAIN_SGML_FILE=gdk4-docs.xml
 
 # Extra options to supply to gtkdoc-scan
 SCAN_OPTIONS=--deprecated-guards=GDK_DISABLE_DEPRECATED \
diff --git a/docs/reference/gdk/gdk-docs.sgml b/docs/reference/gdk/gdk-docs.sgml
deleted file mode 100644 (file)
index b6e3628..0000000
+++ /dev/null
@@ -1,118 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
-<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
-<!ENTITY version SYSTEM "version.xml">
-]>
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
-  <bookinfo>
-    <title>GDK 4 Reference Manual</title>
-    <releaseinfo>
-      This document is for the GDK 4 library, version &version;.
-      The latest versions can be found online at
-      <ulink role="online-location" url="https://developer.gnome.org/gdk4/">https://developer.gnome.org/gdk4/</ulink>.
-      If you are looking for the older GDK 3 series of libraries,
-      see <ulink role="online-location" url="https://developer.gnome.org/gdk3/">https://developer.gnome.org/gdk3/</ulink>.
-    </releaseinfo>
-  </bookinfo>
-
-  <reference id="reference">
-    <title>API Reference</title>
-    <xi:include href="xml/general.xml" />
-    <xi:include href="xml/gdkdisplaymanager.xml" />
-    <xi:include href="xml/gdkdisplay.xml" />
-    <xi:include href="xml/gdkscreen.xml" />
-    <xi:include href="xml/gdkseat.xml" />
-    <xi:include href="xml/gdkmonitor.xml" />
-    <xi:include href="xml/gdkdevice.xml" />
-    <xi:include href="xml/gdkdevicepad.xml" />
-    <xi:include href="xml/regions.xml" />
-    <xi:include href="xml/pixbufs.xml" />
-    <xi:include href="xml/rgba_colors.xml" />
-    <xi:include href="xml/visuals.xml" />
-    <xi:include href="xml/cursors.xml" />
-    <xi:include href="xml/windows.xml" />
-    <xi:include href="xml/gdkframeclock.xml" />
-    <xi:include href="xml/gdkframetimings.xml" />
-    <xi:include href="xml/gdkdrawingcontext.xml" />
-    <xi:include href="xml/gdkglcontext.xml" />
-    <xi:include href="xml/gdkvulkancontext.xml" />
-    <xi:include href="xml/events.xml" />
-    <xi:include href="xml/event_structs.xml" />
-    <xi:include href="xml/keys.xml" />
-    <xi:include href="xml/selections.xml" />
-    <xi:include href="xml/dnd.xml" />
-    <xi:include href="xml/properties.xml" />
-    <xi:include href="xml/threads.xml" />
-    <xi:include href="xml/pango_interaction.xml" />
-    <xi:include href="xml/cairo_interaction.xml" />
-    <xi:include href="xml/x_interaction.xml" />
-    <xi:include href="xml/wayland_interaction.xml" />
-    <xi:include href="xml/gdkapplaunchcontext.xml" />
-  </reference>
-
-  <reference>
-    <title>Deprecated</title>
-    <xi:include href="xml/gdkdevicemanager.xml" />
-  </reference>
-
-  <index id="api-index-full">
-    <title>Index of all symbols</title>
-    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-deprecated" role="deprecated">
-    <title>Index of deprecated symbols</title>
-    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-0" role="3.0">
-    <title>Index of new symbols in 3.0</title>
-    <xi:include href="xml/api-index-3.0.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-2" role="3.2">
-    <title>Index of new symbols in 3.2</title>
-    <xi:include href="xml/api-index-3.2.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-4" role="3.4">
-    <title>Index of new symbols in 3.4</title>
-    <xi:include href="xml/api-index-3.4.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-6" role="3.6">
-    <title>Index of new symbols in 3.6</title>
-    <xi:include href="xml/api-index-3.6.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-8" role="3.8">
-    <title>Index of new symbols in 3.8</title>
-    <xi:include href="xml/api-index-3.8.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-10" role="3.10">
-    <title>Index of new symbols in 3.10</title>
-    <xi:include href="xml/api-index-3.10.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-12" role="3.12">
-    <title>Index of new symbols in 3.12</title>
-    <xi:include href="xml/api-index-3.12.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-14" role="3.14">
-    <title>Index of new symbols in 3.14</title>
-    <xi:include href="xml/api-index-3.14.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-16" role="3.16">
-    <title>Index of new symbols in 3.16</title>
-    <xi:include href="xml/api-index-3.16.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-18" role="3.18">
-    <title>Index of new symbols in 3.18</title>
-    <xi:include href="xml/api-index-3.18.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-20" role="3.20">
-    <title>Index of new symbols in 3.20</title>
-    <xi:include href="xml/api-index-3.20.xml"><xi:fallback /></xi:include>
-  </index>
-  <index id="api-index-3-22" role="3.22">
-    <title>Index of new symbols in 3.22</title>
-    <xi:include href="xml/api-index-3.22.xml"><xi:fallback /></xi:include>
-  </index>
-
-  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
-
-</book>
diff --git a/docs/reference/gdk/gdk3-overrides.txt b/docs/reference/gdk/gdk3-overrides.txt
deleted file mode 100644 (file)
index 3ffff9c..0000000
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# GdkAtom is an opaque typedef
-<STRUCT>
-<NAME>GdkAtom</NAME>
-</STRUCT>
-
-<MACRO>
-<NAME>GDK_WINDOWING_X11</NAME>
-#define GDK_WINDOWING_X11
-</MACRO>
-
-<MACRO>
-<NAME>GDK_WINDOWING_WIN32</NAME>
-#define GDK_WINDOWING_WIN32
-</MACRO>
-
-<MACRO>
-<NAME>GDK_WINDOWING_QUARTZ</NAME>
-#define GDK_WINDOWING_QUARTZ
-</MACRO>
-
-<MACRO>
-<NAME>GDK_WINDOWING_WAYLAND</NAME>
-#define GDK_WINDOWING_WAYLAND
-</MACRO>
-
-<MACRO>
-<NAME>GDK_DISABLE_DEPRECATION_WARNINGS</NAME>
-#define GDK_DISABLE_DEPRECATION_WARNINGS
-</MACRO>
diff --git a/docs/reference/gdk/gdk4-docs.xml b/docs/reference/gdk/gdk4-docs.xml
new file mode 100644 (file)
index 0000000..b6e3628
--- /dev/null
@@ -0,0 +1,118 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>GDK 4 Reference Manual</title>
+    <releaseinfo>
+      This document is for the GDK 4 library, version &version;.
+      The latest versions can be found online at
+      <ulink role="online-location" url="https://developer.gnome.org/gdk4/">https://developer.gnome.org/gdk4/</ulink>.
+      If you are looking for the older GDK 3 series of libraries,
+      see <ulink role="online-location" url="https://developer.gnome.org/gdk3/">https://developer.gnome.org/gdk3/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <reference id="reference">
+    <title>API Reference</title>
+    <xi:include href="xml/general.xml" />
+    <xi:include href="xml/gdkdisplaymanager.xml" />
+    <xi:include href="xml/gdkdisplay.xml" />
+    <xi:include href="xml/gdkscreen.xml" />
+    <xi:include href="xml/gdkseat.xml" />
+    <xi:include href="xml/gdkmonitor.xml" />
+    <xi:include href="xml/gdkdevice.xml" />
+    <xi:include href="xml/gdkdevicepad.xml" />
+    <xi:include href="xml/regions.xml" />
+    <xi:include href="xml/pixbufs.xml" />
+    <xi:include href="xml/rgba_colors.xml" />
+    <xi:include href="xml/visuals.xml" />
+    <xi:include href="xml/cursors.xml" />
+    <xi:include href="xml/windows.xml" />
+    <xi:include href="xml/gdkframeclock.xml" />
+    <xi:include href="xml/gdkframetimings.xml" />
+    <xi:include href="xml/gdkdrawingcontext.xml" />
+    <xi:include href="xml/gdkglcontext.xml" />
+    <xi:include href="xml/gdkvulkancontext.xml" />
+    <xi:include href="xml/events.xml" />
+    <xi:include href="xml/event_structs.xml" />
+    <xi:include href="xml/keys.xml" />
+    <xi:include href="xml/selections.xml" />
+    <xi:include href="xml/dnd.xml" />
+    <xi:include href="xml/properties.xml" />
+    <xi:include href="xml/threads.xml" />
+    <xi:include href="xml/pango_interaction.xml" />
+    <xi:include href="xml/cairo_interaction.xml" />
+    <xi:include href="xml/x_interaction.xml" />
+    <xi:include href="xml/wayland_interaction.xml" />
+    <xi:include href="xml/gdkapplaunchcontext.xml" />
+  </reference>
+
+  <reference>
+    <title>Deprecated</title>
+    <xi:include href="xml/gdkdevicemanager.xml" />
+  </reference>
+
+  <index id="api-index-full">
+    <title>Index of all symbols</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-deprecated" role="deprecated">
+    <title>Index of deprecated symbols</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-0" role="3.0">
+    <title>Index of new symbols in 3.0</title>
+    <xi:include href="xml/api-index-3.0.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-2" role="3.2">
+    <title>Index of new symbols in 3.2</title>
+    <xi:include href="xml/api-index-3.2.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-4" role="3.4">
+    <title>Index of new symbols in 3.4</title>
+    <xi:include href="xml/api-index-3.4.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-6" role="3.6">
+    <title>Index of new symbols in 3.6</title>
+    <xi:include href="xml/api-index-3.6.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-8" role="3.8">
+    <title>Index of new symbols in 3.8</title>
+    <xi:include href="xml/api-index-3.8.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-10" role="3.10">
+    <title>Index of new symbols in 3.10</title>
+    <xi:include href="xml/api-index-3.10.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-12" role="3.12">
+    <title>Index of new symbols in 3.12</title>
+    <xi:include href="xml/api-index-3.12.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-14" role="3.14">
+    <title>Index of new symbols in 3.14</title>
+    <xi:include href="xml/api-index-3.14.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-16" role="3.16">
+    <title>Index of new symbols in 3.16</title>
+    <xi:include href="xml/api-index-3.16.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-18" role="3.18">
+    <title>Index of new symbols in 3.18</title>
+    <xi:include href="xml/api-index-3.18.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-20" role="3.20">
+    <title>Index of new symbols in 3.20</title>
+    <xi:include href="xml/api-index-3.20.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3-22" role="3.22">
+    <title>Index of new symbols in 3.22</title>
+    <xi:include href="xml/api-index-3.22.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+
+</book>
diff --git a/docs/reference/gdk/gdk4-overrides.txt b/docs/reference/gdk/gdk4-overrides.txt
new file mode 100644 (file)
index 0000000..3ffff9c
--- /dev/null
@@ -0,0 +1,30 @@
+
+# GdkAtom is an opaque typedef
+<STRUCT>
+<NAME>GdkAtom</NAME>
+</STRUCT>
+
+<MACRO>
+<NAME>GDK_WINDOWING_X11</NAME>
+#define GDK_WINDOWING_X11
+</MACRO>
+
+<MACRO>
+<NAME>GDK_WINDOWING_WIN32</NAME>
+#define GDK_WINDOWING_WIN32
+</MACRO>
+
+<MACRO>
+<NAME>GDK_WINDOWING_QUARTZ</NAME>
+#define GDK_WINDOWING_QUARTZ
+</MACRO>
+
+<MACRO>
+<NAME>GDK_WINDOWING_WAYLAND</NAME>
+#define GDK_WINDOWING_WAYLAND
+</MACRO>
+
+<MACRO>
+<NAME>GDK_DISABLE_DEPRECATION_WARNINGS</NAME>
+#define GDK_DISABLE_DEPRECATION_WARNINGS
+</MACRO>